package risoe.syslab.fhnew.controller;

/*
 * Copyright (c) 2012-2014, Technical University of Denmark (DTU)
 * All rights reserved.
 * 
 * The Flexhouse 2.0 platform ("this software") is licensed under the
 * BSD 3-clause license.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *   - Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   - Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *   - Neither the name of DTU nor the names of its contributors may be used to
 *     endorse or promote products derived from this software without specific
 *     prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE TECHNICAL UNIVERSITY OF DENMARK BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

import java.util.HashSet;

import risoe.syslab.fhnew.config.BuildingConfig;
import risoe.syslab.fhnew.db.LoggerManager;
import risoe.syslab.fhnew.gui.VisualizationHolder;
import risoe.syslab.fhnew.hw.Actuator;
import risoe.syslab.fhnew.hw.Sensor;
import risoe.syslab.model.CompositeMeasurement;
import risoe.syslab.model.CompositeString;
import risoe.syslab.model.flexhouse.ControllerParameter;

/**
 * The abstract controller implementation for use with the new ControllerManager
 * @author M. Svendsen
 */
public abstract class DefaultController {
	protected ControllerManager mControllerManager;
	protected BuildingConfig mBuildingConfig;
	protected HashSet<ControllerParameter> mControllerParameters = new HashSet<ControllerParameter>();

	// Only called by reflection
	protected DefaultController(ControllerManager manager, BuildingConfig building){
		mBuildingConfig = building;
		mControllerManager = manager;
	}
	
	/**
	 * @return a reference to the LoggerManager instance
	 */
	protected LoggerManager getLoggerManager(){
		return mControllerManager.getLoggerManager();
	}

	/**
	 * Called when a sensor is updated. No filtering is implemented for default controllers.
	 * Any default controller must thus apply the filtering by itself.
	 * @param sensor the sensor that triggered this event
	 */
	public abstract void sensorUpdated(Sensor sensor);
	
	/**
	 * Called when an actuator is updated. No filtering is implemented for default controllers.
	 * Any default controller must thus apply the filtering by itself.
	 * NOTE: To listen to actuators, override this method.
	 * @param actuator the actuator that triggered this event
	 */
	public void actuatorUpdated(Actuator actuator) {};

	/**
	 * Schedules a write.
	 * @param actuatorName the name of the actuator to set
	 * @param value the value to set
	 */
	public void setActuator(String actuatorName, CompositeMeasurement value) {
		mControllerManager.setActuatorDefault(actuatorName, value);
	}
	
	/**
	 * Requests that the default controller delivers a path to a SVG file for visualization
	 * @return a VisualizationHolder created by the default controller
	 */
	public abstract VisualizationHolder getVisualization();

	/**
	 * Stops this controller allowing for cleanup before dereferencing
	 */
	public abstract void kill();
	
	
	protected void controllerParameterUpdated(ControllerParameter parameter, CompositeString value){};
	
	public HashSet<ControllerParameter> getControllerParameters(){
		return mControllerParameters;
	}
}
